powerstep.h File Reference

This file contains API for Power Step Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"

Go to the source code of this file.

Data Structures
struct	powerstep_t
	Power Step Click context object. More...
struct	powerstep_cfg_t
	Power Step Click configuration object. More...

Macros
#define	POWERSTEP_DIR_CW   0
	Power Step direction setting.
#define	POWERSTEP_DIR_CCW   1
#define	POWERSTEP_PIN_LOW_LEVEL   0
	Power Step pin logic level setting.
#define	POWERSTEP_PIN_HIGH_LEVEL   1
#define	POWERSTEP_SPEED_VERY_SLOW   0
	Power Step device speed settings.
#define	POWERSTEP_SPEED_SLOW   1
#define	POWERSTEP_SPEED_MEDIUM   2
#define	POWERSTEP_SPEED_FAST   3
#define	POWERSTEP_SPEED_VERY_FAST   4
#define	POWERSTEP_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	powerstep_return_value_t { POWERSTEP_OK = 0 , POWERSTEP_ERROR = -1 }
	Power Step Click return value data. More...

Functions
void	powerstep_cfg_setup (powerstep_cfg_t *cfg)
	Power Step configuration object setup function.
err_t	powerstep_init (powerstep_t *ctx, powerstep_cfg_t *cfg)
	Power Step initialization function.
void	powerstep_enable_device (powerstep_t *ctx)
	Power Step enable device function.
void	powerstep_disable_device (powerstep_t *ctx)
	Power Step disable device function.
void	powerstep_set_direction (powerstep_t *ctx, uint8_t dir)
	Power Step set direction function.
void	powerstep_switch_direction (powerstep_t *ctx)
	Power Step switch direction function.
void	powerstep_set_rst_pin (powerstep_t *ctx, uint8_t state)
	Power Step set rst pin function.
void	powerstep_reset_device (powerstep_t *ctx)
	Power Step reset device function.
void	powerstep_set_step_pin (powerstep_t *ctx, uint8_t state)
	Power Step set step pin function.
void	powerstep_drive_motor (powerstep_t *ctx, uint32_t steps, uint8_t speed)
	Power Step driver motor function.

Detailed Description

This file contains API for Power Step Click Driver.

Enumeration Type Documentation

powerstep_return_value_t

enum powerstep_return_value_t

Power Step Click return value data.

Predefined enum values for driver return values.

Enumerator
POWERSTEP_OK
POWERSTEP_ERROR